楽天ペイ(オンライン決済)

楽天ペイ 利用承諾 API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却

EntryTranRakutenId 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID 必須 半角英数13桁
ショップID
ShopPass 必須 半角英数64桁
ショップパスワード
OrderID 必須 半角英数記号27桁
オーダーID
JobCd 必須
処理区分

REGISTER：申込み（お客様への注文は行わずに随時決済に必要なサブスクリプションIDの発行を行います）

Amount 必須 半角数字8桁
利用金額

「0」を指定してください。

URL
/payment/EntryTranRakutenId.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=REGISTER&Amount=0
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID
AccessID 半角数字32桁 固定
取引ID
AccessPass 半角数字32桁 固定
取引パスワード
異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranRakutenId 決済実行

これ以降の決済取引で必要となるトークンを返却します。

リクエスト
ShopID 必須 半角英数13桁
ショップID
ShopPass 必須 半角英数64桁
ショップパスワード
AccessID 必須 半角英数32桁 固定
取引ID
AccessPass 必須 半角英数32桁 固定
取引パスワード
OrderID 必須 半角英数記号27桁
オーダーID
ClientField1 全半角100バイト
加盟店自由項目1
ClientField2 全半角100バイト
加盟店自由項目2
ClientField3 全半角100バイト
加盟店自由項目3
RetURL 必須 半角英数記号2048桁
決済結果戻しURL

加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。
楽天ペイ上でお客様が決済手続きを正常に完了された場合に、指定されたURLに結果がリダイレクト経由で送信されます。

ErrorRcvURL 必須 半角英数記号2048桁
処理NG時URL

加盟店様が当サービスからの処理失敗となった結果を受信するための処理NG時URLを設定します。
楽天ペイ上でお客様が決済手続きを正常に完了できなかった場合に、指定されたURLに結果がリダイレクト経由で送信されます。

PaymentTermSec 半角数字5桁
支払開始期限秒

お客様が【決済実行】から【支払手続き開始IF】を呼び出すまでの期限です。
最大86,400秒（1日）
呼び出しパラメータが空の場合、120秒で処理されます。

SubscriptionName 必須 全半角200桁
サブスクリプション名

申込情報として表示されるサブスクリプション名を設定します。最大200文字まで指定できます。
(全角文字はひらがなカタナ数字記号と第 1・2水準の漢字のみになります。4バイト文字は使用できません。)

URL
/payment/ExecTranRakutenId.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive/success&ErrorRcvURL=https://example.com/receive/error&SubscriptionName=サブスクリプション名
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID
Token 半角英数記号256桁 固定
トークン

アクセスIDのハッシュ値を返却します。

StartURL 半角英数記号256桁
支払手続き開始IFのURL

支払手続き開始IFのURLを返却します。

StartLimitDate 半角数字14桁 固定
支払開始期限日時

支払手続き開始IFの呼び出し期限を返却します。
yyyyMMddHHmmss書式

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=rT735NHvr5rGDDFsG/iMIoKv5SEiiINgsNuAZ4G2s+ewBS7yYvxSiC0zeMVH+O5A&StartURL=https://x01.mul-pay.jp/payment/RakutenIdStart.idPass&StartLimitDate=20190225162711
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

RakutenIdStart 支払手続き開始IFの呼び出し

楽天ペイにおいて、お客様を楽天ペイ画面へと遷移させる必要があります。
加盟店様のサイトから画面遷移させる場合は、お客様を当サービスの支払手続き開始IFに誘導してください。
当サービスは、お客様を楽天ペイ画面に誘導します。
※取引が特定できない場合、すでに支払いを済ませている場合、支払期限切れの場合等はエラー画面を表示します。

リクエスト
AccessID 必須 半角英数32桁 固定
取引ID

【取引登録】で発行された値を設定します。

Token 必須 半角英数256桁
トークン

【決済実行】で発行された値を設定します。

URL
/payment/RakutenIdStart.json
URL
/payment/RakutenIdStart.idPass
リダイレクトページサンプル

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="RakutenIdStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
    <noscript>
      <br>
      <br>
      <center>
        <h2>
          楽天ペイ画面へ遷移します。
        </h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
<input type="hidden" name="Token" value="{Token}">
    </form>
    <script >
    <!--
      function OnLoadEvent() {
        document. RakutenIdStartCall.submit();
      }
    //-->
    </script>
    </body>
</html>

決済結果受信

楽天ペイから、当サービスに支払操作結果が通知されます。
支払操作結果は、お客様が支払操作を完了した場合に通知されます。
当サービスは、【決済実行】時に指定されたリダイレクトURLに決済結果を通知します。
この決済結果は、楽天ペイの決済完了画面からブラウザ経由で連携されるため、お客様の操作方法によっては支払操作が完了したにもかかわらず、加盟店様に通知されないことがあります。
その際はショップ管理画面または結果通知にて確認ください。また、同様の理由でこの決済結果が複数回加盟店様に通知されることがあります。

レスポンス
正常
ShopID 必須 半角英数13桁
ショップID
OrderID 必須 半角英数記号27桁
オーダーID
c 必須 半角英数32桁
MD5ハッシュ

チェック用の文字列(CheckString)を返却します。
ShopID＋OrderID＋ショップパスワードをMD5ハッシュした値を返却します。

SubscriptionId 必須 半角数字20桁
サブスクリプションID
異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

PayType 必須 半角数字2桁
決済方法

18：楽天ペイ

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=18
レスポンス
正常
Status
現状態

  • UNPROCESSED：未決済
  • REQSUCCESS：要求成功
  • PAYSTART：決済開始
  • PAYFAIL：決済失敗
  • EXPIRED：期限切れ
  • AUTH：仮売上
  • CAPTURE：即時売上
  • REQSALES：実売上受付
  • REQCANCEL：キャンセル受付
  • REQCHANGE：金額変更受付
  • SALES：実売上
  • CANCEL：キャンセル
  • REGISTER：申込完了
  • REQAUTH：仮売上受付
  • REQCAPTURE：即時売上受付
ProcessDate 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

Amount 半角数字8桁
利用金額

Tax 半角数字8桁
税送料

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

PayType 半角数字2桁
決済方法

18：楽天ペイ

JobCd
処理区分

AUTH：仮売上
CAPTURE：即時売上
REGISTER：申込

OrderDate 半角数字14桁 固定
注文日

yyyyMMddHHmmss書式

CompletionDate 半角数字8桁 固定
完了日

売上確定、注文キャンセル、注文金額変更処理の完了日を返却します。
yyyyMMdd書式

RakutenidCouponFee 半角数字8桁
クーポン金額

決済時に使用されたクーポンの金額です。クーポンが使用されていない取引の場合、0になります。

SubscriptionId
サブスクリプションID

SettlementSubscriptionId
決済用サブスクリプションID

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
Status=AUTH&ProcessDate=20201225091313&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=100&Tax=8&ClientField1=&ClientField2=&ClientField3=&PayType=18&JobCd=AUTH&OrderDate=20201225091313&CompletionDate=20220801&RakutenidCouponFee=0&SubscriptionId=&SettlementSubscriptionId=
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001